/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry;

import java.io.IOException;
import java.io.InputStream;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * IEnvelopeReader
 *
 * @since 2021-06-02
 **/
public interface IEnvelopeReader {

    /**
     * read envelope
     *
     * @param stream data inputStream
     * @return SentryEnvelope
     * @throws IOException exception 
     */
    @Nullable
    SentryEnvelope read(@NotNull InputStream stream) throws IOException;
}
